Update and lint discovery topics #2403
Conversation
|
💻 Deploy preview available: https://deploy-preview-alloy-2403-zb444pucvq-vp.a.run.app/docs/alloy/latest/ |
|
Related issue #2411 |
clayton-cornell
changed the title
clayton-cornell
added
the
type/docs
| - _`<USERNAME>`_: The username to use for authentication to the `remote_write` API. | ||
| - _`<PASSWORD>`_: The password to use for authentication to the `remote_write` API. | ||
|
|
||
| * _`<PROMETHEUS_REMOTE_WRITE_URL>`_: The URL of the Prometheus remote_write-compatible server to send metrics to. |
There was a problem hiding this comment.
Should these be alpha order?
There was a problem hiding this comment.
I thought about that.... right now that are all in the order they are encountered in the config file.
| authorization | [authorization][] | Configure generic authorization to the endpoint. | no | ||
| oauth2 | [oauth2][] | Configure OAuth2 for authenticating to the endpoint. | no | ||
| basic_auth | [basic_auth][] | Configure `basic_auth` for authenticating to the endpoint. | no | ||
| oauth2 | [oauth2][] | Configure OAuth 2.0 for authenticating to the endpoint. | no | ||
| oauth2 > tls_config | [tls_config][] | Configure TLS settings for connecting to the endpoint. | no |
There was a problem hiding this comment.
Should this description somehow distinguish the purpose of the oauth2 > tls_config vs higher level tls_config?
There was a problem hiding this comment.
The descriptions in the Blocks tables are weak in a lot of places. This is something I think we could defer to a separate issue and revisit.
Created #2442 to track this
| - _`<PROMETHEUS_REMOTE_WRITE_URL>`_: The URL of the Prometheus remote_write-compatible server to send metrics to. | ||
| - _`<USERNAME>`_: The username to use for authentication to the remote_write API. | ||
| - _`<PASSWORD>`_: The password to use for authentication to the remote_write API. | ||
| * _`<PROMETHEUS_REMOTE_WRITE_URL>`_: The URL of the Prometheus remote_write-compatible server to send metrics to. |
There was a problem hiding this comment.
Not going to mark each of these, but should this also be alpha order?
| * _`<USERNAME>`_: The username to use for authentication to the remote_write API. | ||
| * _`<PASSWORD>`_: The password to use for authentication to the remote_write API. | ||
|
|
||
| {{< admonition type="note" >}} |
There was a problem hiding this comment.
Should the note be at the top of the example?
PR Description
Splitting Discovery updates into multiple PRs to make reviews a bit easier.
Changes include:
Which issue(s) this PR fixes
Notes to the Reviewer
PR Checklist